<!DOCTYPE html>
<html>
  <head>
  <meta charset='UTF-8'>
  <title>Atom API Documentation</title>
  <link rel='stylesheet' href='../assets/biscotto.css' type='text/css'>
  <script src='../assets/biscotto.js'></script>
  <script src='../assets/search_data.js'></script>
</head>
  <body>
    <div id='base' data-path='..&#47;'></div>
<div id='header'>
  <div id='menu'>
    <a href='../docs/README.md.html' title='Atom'>Atom</a>
    &raquo;
    <a href='../class_index.html' title='Index'>Index</a>
    &raquo;
    <span class='title'>Project</span>
    <nav>
      <ul>
        <li class='noframes'>
          (<a class='noframes' href='Project.html#'>no frames</a>)
        </li>
      </ul>
    </nav>
    <div id='search'>
      <a id='class_list_link' href='../class_list.html'>Classes</a>
      <a id='file_list_link' href='../file_list.html'>Files</a>
      <a id='method_list_link' href='../method_list.html'>Methods</a>
      <a id='extra_list_link' href='../extra_list.html'>Extras</a>
    </div>
  </div>
  <iframe id='search_frame'></iframe>
  <div id='fuzzySearch'>
    <input type='text'>
    <ol></ol>
  </div>
  <div id='help'>
    <p>
      Quickly fuzzy find classes, mixins, methods, file:
    </p>
    <ul>
      <li>
        <span>Ctrl-T</span>
        Open fuzzy finder dialog
      </li>
    </ul>
    <p>
      In frame mode you can toggle the list naviation frame on the left side:
    </p>
    <ul>
      <li>
        <span>Ctrl-L</span>
        Toggle list view
      </li>
    </ul>
    <p>
      You can focus a list in frame mode or toggle a tab in frameless mode:
    </p>
    <ul>
      <li>
        <span>Ctrl-C</span>
        Class list
      </li>
      <li>
        <span>Ctrl-I</span>
        Mixin list
      </li>
      <li>
        <span>Ctrl-F</span>
        File list
      </li>
      <li>
        <span>Ctrl-M</span>
        Method list
      </li>
      <li>
        <span>Ctrl-E</span>
        Extras list
      </li>
    </ul>
    <p>
      You can focus and blur the search input:
    </p>
    <ul>
      <li>
        <span>Ctrl-S</span>
        Focus search input
      </li>
      <li>
        <span>Esc</span>
        Blur search input
      </li>
    </ul>
    <p>
      In frameless mode you can close the list tab:
    </p>
    <ul>
      <li>
        <span>Esc</span>
        Close list tab
      </li>
    </ul>
  </div>
</div>
    <div id='content'>
      <h1>
        Class
        Project
      </h1>
      <div class='stability-1'>
        <span class='heading'></span>
        <div class='message'></div>
      </div>
      <table class='box'>
        <tr>
          <td>Defined in:</td>
          <td>src&#47;project.coffee</td>
        </tr>
        <tr>
          <td>Inherits:</td>
          <td>
            <a href='https://atom.io/docs/api/v0.67.0/api/classes/Model.html'>Model</a>
          </td>
        </tr>
      </table>
      <h2>Overview</h2>
      <div class='docstring'>
  <p>Represents a project that&#39;s opened in Atom.</p><p>An instance of this class is always available as the <code>atom.project</code> global. </p>
</div>
<div class='tags'>
</div>
      <h2>Class Method Summary</h2>
      <ul class='summary'>
  <li>
    <span class='signature'>
      <a href='Project.html#pathForRepositoryUrl-class'>
        .<strong>pathForRepositoryUrl</strong>(repoUrl)
      </a>
    </span>
    <span class='desc'>
      Find the local path for the given repository URL.
    </span>
  </li>
</ul>
      <h2>Instance Method Summary</h2>
      <ul class='summary'>
  <li>
    <span class='signature'>
      <a href='Project.html#contains-instance'>
        ::<strong>contains</strong>(pathToCheck)
      </a>
    </span>
    <span class='desc'>
      Returns whether the given path is inside this project.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Project.html#getPath-instance'>
        ::<strong>getPath</strong>()
      </a>
    </span>
    <span class='desc'>
      Returns the project&#39;s fullpath.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Project.html#getRepo-instance'>
        ::<strong>getRepo</strong>()
      </a>
    </span>
    <span class='desc'>
      Returns the <a href='Git.html'>Git</a> repository if available.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Project.html#getRootDirectory-instance'>
        ::<strong>getRootDirectory</strong>()
      </a>
    </span>
    <span class='desc'>
      Returns the root <a href='Directory.html'>Directory</a> object for this project.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Project.html#relativize-instance'>
        ::<strong>relativize</strong>(fullPath)
      </a>
    </span>
    <span class='desc'>
      Make the given path relative to the project directory.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Project.html#replace-instance'>
        ::<strong>replace</strong>(regex, replacementText, filePaths, iterator)
      </a>
    </span>
    <span class='desc'>
      Performs a replace across all the specified files in the project.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Project.html#resolve-instance'>
        String ::<strong>resolve</strong>(uri)
      </a>
    </span>
    <span class='desc'>
      Given a uri, this resolves it relative to the project directory.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Project.html#scan-instance'>
        ::<strong>scan</strong>(regex, options = {}, iterator)
      </a>
    </span>
    <span class='desc'>
      Performs a search across all the files in the project.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Project.html#setPath-instance'>
        ::<strong>setPath</strong>(projectPath)
      </a>
    </span>
    <span class='desc'>
      Sets the project&#39;s fullpath.
    </span>
  </li>
</ul>
      <h2>Class Method Details</h2>
      <div class='methods'>
  <div class='method_details'>
    <p class='signature' id='pathForRepositoryUrl-class'>
      .<strong>pathForRepositoryUrl</strong>(repoUrl)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Find the local path for the given repository URL.</p>
</div>
<div class='tags'>
</div>
  </div>
</div>
      <h2>Instance Method Details</h2>
      <div class='methods'>
  <div class='method_details'>
    <p class='signature' id='contains-instance'>
      ::<strong>contains</strong>(pathToCheck)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns whether the given path is inside this project.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getPath-instance'>
      ::<strong>getPath</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns the project&#39;s fullpath.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getRepo-instance'>
      ::<strong>getRepo</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns the <a href='Git.html'>Git</a> repository if available.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getRootDirectory-instance'>
      ::<strong>getRootDirectory</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns the root <a href='Directory.html'>Directory</a> object for this project.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='relativize-instance'>
      ::<strong>relativize</strong>(fullPath)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Make the given path relative to the project directory.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='replace-instance'>
      ::<strong>replace</strong>(regex, replacementText, filePaths, iterator)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Performs a replace across all the specified files in the project.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='type'>(RegExp)</span>
      <span class='name'>regex</span>
      &mdash;
      <span class='desc'>A <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/RegExp'>RegExp</a> to search with.</span>
    </li>
    <li>
      <span class='name'>replacementText</span>
      &mdash;
      <span class='desc'>Text to replace all matches of regex with</span>
    </li>
    <li>
      <span class='name'>filePaths</span>
      &mdash;
      <span class='desc'>List of file path strings to run the replace on.</span>
    </li>
    <li>
      <span class='type'>(Function)</span>
      <span class='name'>iterator</span>
      &mdash;
      <span class='desc'>A <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Function'>Function</a> callback on each file with replacements: <code>({filePath, replacements}) -&gt;</code>.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='resolve-instance'>
      String ::<strong>resolve</strong>(uri)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Given a uri, this resolves it relative to the project directory. If the path is already absolute or if it is prefixed with a scheme, it is returned unchanged.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='type'>(String)</span>
      <span class='name'>uri</span>
      &mdash;
      <span class='desc'>The <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> name of the path to convert.</span>
    </li>
  </ul>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      (<tt>String</tt>)
      &mdash;
      <span class='desc'>Returns a <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> or undefined if the uri is not missing or empty.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='scan-instance'>
      ::<strong>scan</strong>(regex, options = {}, iterator)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Performs a search across all the files in the project.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='type'>(RegExp)</span>
      <span class='name'>regex</span>
      &mdash;
      <span class='desc'>A <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/RegExp'>RegExp</a> to search with.</span>
    </li>
    <li>
      <span class='type'>(Object)</span>
      <span class='name'>options</span>
      &mdash;
      <span class='desc'>An optional options <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object'>Object</a> (default: {}):</span>
    </li>
    <ul class='options'>
      <li>
        <span class='type'>(Array)</span>
        <span class='name'>paths</span>
        &mdash;
        <span class='desc'>An <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Array'>Array</a> of glob patterns to search within</span>
      </li>
    </ul>
    <li>
      <span class='type'>(Function)</span>
      <span class='name'>iterator</span>
      &mdash;
      <span class='desc'>A <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Function'>Function</a> callback on each file found</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='setPath-instance'>
      ::<strong>setPath</strong>(projectPath)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Sets the project&#39;s fullpath.</p>
</div>
<div class='tags'>
</div>
  </div>
</div>
    </div>
    <div id='footer'>
  Generated on
  Wed Mar 05 2014 08:55:13 GMT-0700 (MST)
  by
  <a href='https://github.com/gjtorikian/biscotto' title='TomDoc-CoffeeScript API documentation generator'>Biscotto</a>
  v2.1.1
  (Node.js v0.10.22).
  &#10034;
  Press Ctrl-h to see the keyboard shortcuts
</div>
  </body>
</html>